p-timeout

Timeout a Promise

This feature allows you to set a timeout for a Promise. If the Promise does not resolve or reject within the specified time, it will be rejected with a TimeoutError.

const pTimeout = require('p-timeout');

const doSomething = () => new Promise(resolve => setTimeout(resolve, 2000));

pTimeout(doSomething(), 1000).then(() => console.log('Resolved')).catch(error => console.log('Timed out:', error.message));

Custom Timeout Error

This feature allows you to specify a custom error message for the timeout. If the Promise times out, it will be rejected with a TimeoutError that contains your custom message.

const pTimeout = require('p-timeout');
const TimeoutError = pTimeout.TimeoutError;

const doSomething = () => new Promise(resolve => setTimeout(resolve, 2000));

pTimeout(doSomething(), 1000, 'Operation timed out').then(() => console.log('Resolved')).catch(error => {
  if (error instanceof TimeoutError) {
    console.log('Custom timeout message:', error.message);
  }
});

Clearing the Timeout

This feature allows you to clear the timeout before it occurs. This is useful if the conditions of your operation change and you no longer require the timeout.

const pTimeout = require('p-timeout');

const doSomething = () => new Promise(resolve => setTimeout(resolve, 2000));

const promiseWithTimeout = pTimeout(doSomething(), 1000);
promiseWithTimeout.then(() => console.log('Resolved')).catch(error => console.log('Timed out:', error.message));

// Later, if you decide you no longer want the timeout:
pTimeout.clear(promiseWithTimeout);